﻿//==============================================================================
// File: ValidationResult.cs
// Created: 2010-05-10
// Author: Piotr Włodek
//==============================================================================
// This file is a part of MAMMOTH project.
// Copyright (C) 2010 AGH University of Science and Technology, Krakow.
// https://caribou.iisg.agh.edu.pl/trac/mammoth
//
// Mammoth is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// Mammoth is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with WpfRcp. If not, see http://www.gnu.org/licenses/.
//==============================================================================

using System;

namespace WpfRcp.PropertyModel.Validation
{
    /// <summary>
    /// Represents a validation result.
    /// </summary>
    [Serializable]
    public sealed class ValidationResult
    {
        /// <summary>
        /// Represents a successfull <see cref="ValidationResult"/> result.
        /// </summary>
        public static readonly ValidationResult Valid = new ValidationResult(true);

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="isValid">Value indicating whether property's value is valid.</param>
        /// <param name="error">String representation of the error.</param>
        public ValidationResult(bool isValid, string error)
        {
            if (error == null)
                error = string.Empty;

            Error = error;
            IsValid = isValid;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="isValid">Value indicating whether property's value is valid.</param>
        public ValidationResult(bool isValid)
        {
            IsValid = isValid;
            Error = string.Empty;
        }

        /// <summary>
        /// Gets a value indicating whether property's value is valid.
        /// </summary>
        public bool IsValid { get; private set; }

        /// <summary>
        /// Gets a string representation of the error.
        /// </summary>
        public string Error { get; private set; }
    }
}